Skip to content

docs: add 'How to add a provider' guide and link it in README (GPT5)#16

Merged
theFong merged 1 commit intomainfrom
devin/1754698090-add-provider-guide
Aug 9, 2025
Merged

docs: add 'How to add a provider' guide and link it in README (GPT5)#16
theFong merged 1 commit intomainfrom
devin/1754698090-add-provider-guide

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Aug 9, 2025

docs: add 'How to add a provider' guide and link it in README

This PR adds a comprehensive “How to add a provider” guide and links it from the main README.

Requested by: Alec Fong (@theFong)
Link to Devin run: https://app.devin.ai/sessions/0459b0ec7cc14278a6a5244af378a333

Summary of changes:

  • Add docs/how-to-add-a-provider.md
    • Step-by-step instructions to implement a new provider
    • Canonical references to Lambda Labs provider (client, instance, capabilities)
    • Links to key docs: docs/ARCHITECTURE.md, docs/SECURITY.md, docs/VALIDATION_TESTING.md, pkg/v1/*.go
    • Copy/paste scaffolds for credentials, client, capabilities, and instance ops
  • Update README.md
    • Add a prominent link to the new guide in the Documentation section

Verification:

  • make lint: passed
  • make test: passed

Notes:

  • Docs-only changes; no provider code modified.
  • CI should pass without provider credentials (validation tests are skipped under -short in default test).

Co-Authored-By: Alec Fong <alecsanf@usc.edu>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@devin-ai-integration
Copy link
Contributor Author

Link to Devin run: https://app.devin.ai/sessions/0459b0ec7cc14278a6a5244af378a333

Requested by: Alec Fong (@theFong)

Summary:

  • Adds docs/how-to-add-a-provider.md (step-by-step guide using Lambda Labs as the canonical example)
  • Updates README.md to link the new guide

Happy to address any feedback directly on this PR.

@theFong theFong changed the title docs: add 'How to add a provider' guide and link it in README docs: add 'How to add a provider' guide and link it in README (GPT5) Aug 9, 2025
@theFong theFong merged commit cb9c95c into main Aug 9, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant